CGM.h

Go to the documentation of this file.

#ifndef _CGM_H
#define _CGM_H

/*
 **************************************************************
 * Defines, Macros and Typedefs 
 **************************************************************/
/*** Constant Macros ***/
/* Default Yes and No defines */
#ifndef TRUE
 #define TRUE (1u)
#endif
#ifndef CLEAR
 #define CLEAR (0u)
#endif
#ifndef BITS_IN_NIBBLE
 #define BITS_IN_NIBBLE (4u)
#endif
#ifndef BITS_IN_BYTE
 #define BITS_IN_BYTE (8u)
#endif
#ifndef BYTES_IN_16
 #define BYTES_IN_16  (2u)
#endif
#ifndef BYTES_IN_32
 #define BYTES_IN_32  (4u)
#endif
#ifndef BIT_DEFINITION
 #define BIT_DEFINITION
 #define BIT0  (1u << 0u)
 #define BIT1  (1u << 1u)
 #define BIT2  (1u << 2u)
 #define BIT3  (1u << 3u)
 #define BIT4  (1u << 4u)
 #define BIT5  (1u << 5u)
 #define BIT6  (1u << 6u)
 #define BIT7  (1u << 7u)
 #define BIT8  (1u << 8u)
 #define BIT9  (1u << 9u)
 #define BIT10 (1u << 10)
 #define BIT11 (1u << 11)
 #define BIT12 (1u << 12)
 #define BIT13 (1u << 13)
 #define BIT14 (1u << 14)
 #define BIT15 (1u << 15)
 #define BIT16 (1u << 16)
 #define BIT17 (1u << 17)
 #define BIT18 (1u << 18)
 #define BIT19 (1u << 19)
 #define BIT20 (1u << 20)
 #define BIT21 (1u << 21)
 #define BIT22 (1u << 22)
 #define BIT23 (1u << 23)
 #define BIT24 (1u << 24)
 #define BIT25 (1u << 25)
 #define BIT26 (1u << 26)
 #define BIT27 (1u << 27)
 #define BIT28 (1u << 28)
 #define BIT29 (1u << 29)
 #define BIT30 (1u << 30)
 #define BIT31 (1u << 31)
#endif

#define N_OF_PLL_INSTANCES 2u

/* Below default settings to reach 16MHz */
#define IDF_SETTING_FOR_16MHZ  ((uint8_t)4u)
#define LDF_SETTING_FOR_16MHZ  ((uint8_t)32u)
#define ODF_SETTING_FOR_16MHZ  ((uint8_t)3u)

/* Below default settings to reach 64MHz */
#define IDF_SETTING_FOR_64MHZ  ((uint8_t)4u)
#define LDF_SETTING_FOR_64MHZ  ((uint8_t)64u)
#define ODF_SETTING_FOR_64MHZ  ((uint8_t)2u)

/* Below masks for configuration of CLKOUT */
#define CLK_OUT_ENABLE         ((uint8_t)0x80u)
#define CLK_OUT_DISABLE        ((uint8_t)0x00u)
#define CLK_OUT_DIV_BY_1       ((uint8_t)0x00u)
#define CLK_OUT_DIV_BY_2       ((uint8_t)0x10u)
#define CLK_OUT_DIV_BY_4       ((uint8_t)0x20u)
#define CLK_OUT_DIV_BY_8       ((uint8_t)0x30u)
#define CLK_OUT_SOURCE_IRC     ((uint8_t)0x00u)
#define CLK_OUT_SOURCE_PLL0    ((uint8_t)0x02u)
#define CLK_OUT_SOURCE_PLL1    ((uint8_t)0x03u)
#define CLK_OUT_SOURCE_XOSC    ((uint8_t)0x01u)

/* Error masks */
#define INVALID_PLL_INSTANCE   BIT0

#define INVALID_PLL_DIVIDER    BIT1

#define PLL_DID_NOT_LOCK       BIT2

/*** Function Macros ***/
#ifndef N_ELEMENTS
 #define N_ELEMENTS(X)           (sizeof(X)/sizeof(*(X)))
#endif

/*** Enums ***/
enum PLL_INSTANCES
{
  PLL_INSTANCE_0 = 0u, PLL_INSTANCE_1
};
/*** TypeDefs ***/
typedef union
{
  uint8_t u8;
  struct
  {
    uint8_t Enable    :1;
    uint8_t Reserved  :1;
    uint8_t Divisor   :2;
    uint8_t Source    :4;
  }P;
}CGMCLKOutConfig_t;
/*
 **************************************************************
 * Declarations 
 **************************************************************/
/*** Extern ***/

/*** Globals ***/

/*** Static Globals ***/

/*
 **************************************************************
 * Function Prototypes 
 **************************************************************/
/*
 ******************************************************************************
 *
 * Function:          vfnClockOutputEnable()
 *
 */
void vfnClockOutputEnable(CGMCLKOutConfig_t tMyCGMConfig);
/*
 ******************************************************************************
 *
 * Function:          u8fnClockPLLConfig()
 *
 */
uint8_t u8fnClockPLLConfig(uint8_t u8PLLInstance, uint8_t u8IDF, uint8_t u8ODF,
                           uint8_t u8LDF);
/*
 ******************************************************************************
 *
 * Function:          vfnClearPLLFlag()
 *
 */
void vfnClockClearPLLFlag(uint8_t u8PLLInstance);
#endif /* _FILENAME_H */